﻿//-----------------------------------------------------------------------
// <copyright file="CreateData.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Common
{
    using System;

    /// <summary>
    /// Abstract class which acts as a base for object creation data.
    /// 
    /// Provides a validation function to ensure the creation data is correct.
    /// </summary>
    public abstract class CreateData
    {
        /// <summary>
        /// Static method to validate the passed creation data and check
        /// to make sure that it is not null.
        /// </summary>
        /// <param name="createData">Creation data to validate.</param>
        public static void Validate(CreateData createData)
        {
            if (createData == null)
            {
                throw new ArgumentNullException("createData", "Create data must be non-null.");
            }

            createData.Validate();
        }

        /// <summary>
        /// Validate the creation data and ensure it is correct.
        /// </summary>
        public virtual void Validate()
        {
        }
    }
}
